reservations-eapi icon

reservations-eapi

(0 reviews)

Availability - Status Codes

When requesting availability the same passenger may have a different status code applicable to them depending on when they are travelling and/or on what products they are looking to purchase. For example, a passenger holding a 16-25 railcard would be associated with a status code of 003 when they are travelling on an off-peak service in standard class, but when travelling on a peak service or with a first class fare the applicable status code for them would be 000 (standard adult) as the 16-25 discount doesn't apply to this service and/or product.

The recommended way to request availability information for a passenger whose associated status code may vary is:

  • to first request availability for their underlying status code
    • 000 for Adults
    • 001 for Children
  • If that indicates availability for a bundle then no further checks are necessary and the returned information can be used to make a booking
  • if the initial request indicates a lack of availability for a bundle then consumers can optionally construct and send a follow-up availability request using the associated status code (e.g. 003 for the 16-25 railcard holder example) for those bundles whose outcome was not FULL_AVAILABILITY.
  • If this follow-up query indicates FULL_AVAILABILITY for any of these bundles then these can be added to the list of products which can be used to make a booking

When submitting the booking, use the status code associated to a product's FULL_AVAILABILITY response. So in the above example, if status code 000 renders a FULL AVAILABILITY response with a tariff code for a product, use that status code and tariff code when doing the booking. However, if status code 003 was used to get a FULL_AVAILABILITY response and tariff code for a product then use that status code and tariff code when making the booking.


Last update: 02-Aug-2024 15.12: ASSIST API Documentation Maintenance: 'reservations-eapi', Version 'v2', Page 'Availability - Status Codes', Revision 'A'.

To request updates to this text please contact Neil Barkham.


Reviews